-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Core: Fix filters not being applied in WebKit #26949
Conversation
This ensures that when checking if there is an index to reset, it's not using stale data from before the index was even fully fetched.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit cfe6e11. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
I tried an alternative solution, where This worked too but felt like too tight a coupling between the filter and the store. |
Works on #25852
This ensures that when checking if there is an index to reset, it's not using stale data from before the index was even fully fetched.
What I did
The
setFilter
function will reset the index after the filter has been added, in an attempt to apply the filter to the index - but it will not reset the index if there isn't any index yet. The problem here was that it was potentially using stale index data to determine if the index was there or not to be reset. It wouldThis PR switches around step 1 and 2.
When getting the index and setting filters on initial load, there's a race condition happening between:
In Chromium, the fetch was consistently 120ms while registering filters was about 20 ms. This meant that registering filters would always be first, which was good because then the
setIndex
call after fetch would use the registered filters.However in WebKit the race was most often reversed - fetch taking 20ms and registering filters taking 120 ms. I assume this is because WebKit give higher priority to fetches. This would result in the index being set before the filters had been added to the store state, and thus the filters would be ignored.
This race still occurs. But now, when filters are applied after the index has been initially set,
setFilter
will trigger a newsetIndex
with the filter.Nothing changes in Chromium,
setIndex
will still run after filters, and only run once.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
/?path=/story/lib-preview-api-tags--inheritance
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>